Skip to main content

Get All Properties

Get all properties for a given the user.

HTTP Request​

GET https://dev.calry.app/api/v2/vrs/properties

Headers​

HeaderValue
AuthorizationBearer YOUR_ACCESS_TOKEN
workspaceIdYOUR_WORKSPACE_ID
integrationAccountIdYOUR_INTEGRATION_ACCOUNT_ID

Query Parameters​

ParameterTypeDescription
realtimeboolIf true, the response will be streamed in real-time.

Example Request​

curl --location 'https://dev.calry.app/api/v2/vrs/properties' \
--header 'Authorization: Bearer eyJraWQiOiJzLWE5MGU1M2Q0LTJiNzktNDc2ZS1iNDA0LWI2YzQ2MzE2NmY5ZCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjVlNWRkMWE2LTA5NGItNDI4ZS1hMDRmLTBmMmUyMDgwMTgxZiIsIndvcmtzcGFjZUlkIjoiNzI0NmU0jctNzUzYjlkZjJkMzFmIiwibmFtZSI6InRlc3QtdG9rZW4iLCJzb3VyY2UiOiJtaWNyb3NlcnZpY2UiLCJpYXQiOjE3MDA0Nzc0NDksImV4cCI6MTcwMDgzNzQ0OX0.XqZs7DfFI4PuxkNi3fxPZ-xKcNUtWdhUpVf34B05xRxkWqxlRYSO8OPTg6GEPmnAHwVknKdHzLukAowH4MPpHVTTIPM7gVdhkwCcI-sfJ_HFiBxT-myDN1pQGlp8uHbg0TmiOWe23ENuqAfIIAY_XZa6TzzOQdQzAsjhG8xamkxsgQxXdzYo_dUApfchYeZ5qCGodtF3BvB1mxBD-eQHTSY4VLk2zC2QY1vWIKMa_scWUWUJ4lqtqwawKUVOQlz2Hm_W7Z9RBF7InJbrLBYK1EB6YSVLyeBz1Y-CdysBupuYn2130MXHauPNZcf9z_05g59XBXMW5_Qstcs-EaEntw' \
--header 'workspaceId: 7246e4f5-d8f2-4c01-abb7-753b9df2d31f' \
--header 'integrationAccountId: a2e1738e-9e30-4ba0-808a-fd3f1ce6369a'

Example Response​

{
    "success": true,
    "data": [
        {
            "id": "66137b0c954f5a0012a0fd1a",
            "name": "Cozy Twin in Millbrae Premium Residential Area nea",
            "internalName": "Welcome to home away",
            "description": "This is description",
            "type": "Apartment",
            "status": "ACTIVE",
            "thumbnailUrl": "https://assets.guesty.com/image/upload/c_fit,h_200/v1712552676/production/660ef9677743b2f17d12d5a0/vbateh0lkuytedjw47rb.jpg",
            "address": {
                "line1": "Westshore Road 3799, 94923 Bodega Bay, United States",
                "postal_code": "",
                "city": "Bodega Bay",
                "state": "California",
                "country": "United States"
            },
            "geoLocation": {
                "latitude": 38.3029869,
                "longitude": -123.0571575
            },
            "startPrice": 200,
            "currency": "USD",
            "timeZone": "America/Los_Angeles",
            "rating": {
                "average": null
            },
            "roomTypes": [
                {
                    "id": "66137b0c954f5a0012a0fd1a",
                    "name": "Cozy Twin in Millbrae Premium Residential Area nea"
                }
            ]
        },
        {
            "id": "672262be1e16ca008dd5d5ca",
            "name": "This is your welcome home",
            "internalName": "Multi Unit Listing",
            "description": "",
            "type": "Apartment",
            "status": "ACTIVE",
            "thumbnailUrl": "https://assets.guesty.com/image/upload/c_fit,h_200/v1730306644/production/660ef9677743b2f17d12d5a0/rlexi9hvpl71b0bce39c.jpg",
            "address": {
                "line1": "Divyasree Elan Homes, ELAN HOMES, Sarjapur - Marathahalli Rd, Bellandur, Bengaluru, Karnataka 560035, India",
                "postal_code": "",
                "city": "Bengaluru",
                "state": "Karnataka",
                "country": "India"
            },
            "geoLocation": {
                "latitude": 12.9182479,
                "longitude": 77.67351649999999
            },
            "startPrice": 200,
            "currency": "USD",
            "timeZone": "Asia/Calcutta",
            "rating": {
                "average": null
            },
            "roomTypes": [
                {
                    "id": "672262be1e16ca008dd5d5ca",
                    "name": "This is your welcome home"
                }
            ]
        },
        {
            "id": "6741b0cc32fa7b000f663510",
            "name": "Comfy, Quiet, Luxurious room in a spacious 3 BHK",
            "internalName": "Comfy, Quiet",
            "description": "Located on the 8th floor of a gated society, this apartment has an amazingly peacful vibe. The living room has a spacious balcony, a huge television to binge shows & 7-seater sofa to chill with your friends.\n\nThe apartment is located at a reasonable distance from major offices in Mahadevpura & Old Madras road. The house is equipped with a fully functional kitchen, regular housekeeping and high speed internet. \n\nThe room has a private washroom, a balcony with pool view & elegant wooden flooring.",
            "type": "Condominium",
            "status": "ACTIVE",
            "thumbnailUrl": "https://assets.guesty.com/image/upload/c_fit,h_240/listing_images_s3/production/property-photos/37f58cd50730d696cf4176de5ee56284658491d2059289c4/6741b0cc32fa7b000f663510-49237363_1226036074",
            "address": {
                "line1": "Block C, FCI Godown Rd, Jyothi Puram, Dooravani Nagar, Bengaluru, Karnataka 560016, India",
                "postal_code": "",
                "city": "Bengaluru",
                "state": "Karnataka",
                "country": "India"
            },
            "geoLocation": {
                "latitude": 12.9982866,
                "longitude": 77.6701994
            },
            "startPrice": 1000,
            "currency": "INR",
            "timeZone": "Asia/Calcutta",
            "rating": {
                "average": null
            },
            "roomTypes": [
                {
                    "id": "6741b0cc32fa7b000f663510",
                    "name": "Comfy, Quiet, Luxurious room in a spacious 3 BHK"
                }
            ]
        },
        {
            "id": "6741b0d436b6fc00106b028b",
            "name": "Private room in a cozy 3 BHK",
            "internalName": "3rd C Cross",
            "description": "Take it easy and cozy at this beautiful 3 BHK, designed to suit your travel, work and leisure needs. Your room is equipped with an attached private bath, a workstation, a dressing area and heavily ventilated windows.\n\nThe apartment is located at less than 500 metres away from all major eateries, and less than 3 Km from Manyata Tech Park. It's equipped with a fully functional kitchen, a living room with TV and a small balcony to get some fresh air & enjoy the spring season.",
            "type": "Studio",
            "status": "ACTIVE",
            "thumbnailUrl": "https://assets.guesty.com/image/upload/c_fit,h_240/listing_images_s3/production/property-photos/37f58cd50730d696cf4176de5ee56284658491d2059289c4/6741b0d436b6fc00106b028b-886673950296950989_1646346432",
            "address": {
                "line1": "3rd Cross Rd, Basaveshwar Nagar, Bengaluru, Karnataka 560079, India",
                "postal_code": "",
                "city": "Bengaluru",
                "state": "Karnataka",
                "country": "India"
            },
            "geoLocation": {
                "latitude": 12.9961814,
                "longitude": 77.5376506
            },
            "startPrice": 1100,
            "currency": "INR",
            "timeZone": "Asia/Calcutta",
            "rating": {
                "average": null
            },
            "roomTypes": [
                {
                    "id": "6741b0d436b6fc00106b028b",
                    "name": "Private room in a cozy 3 BHK"
                }
            ]
        }
    ],
    "meta": {
        "limit": 10,
        "cursors": {
            "previous": "",
            "current": "",
            "next": "eyJuZXh0Q3Vyc29yIjp7Imxpc3RpbmdJZCI6IjY3NDFiMGQ0MzZiNmZjMDAxMDZiMDI4YiJ9fQ=="
        }
    }
}